home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmClipboardInquireFormat.z / XmClipboardInquireFormat
Encoding:
Text File  |  2003-11-18  |  5.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_C_l_i_p_b_o_a_r_d_I_n_q_u_i_r_e_F_o_r_m_a_t - A clipboard function that returns
  10.       a specified format name
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       #include <Xm/Xm.h>
  14.       #include <Xm/CutPaste.h>
  15.  
  16.       int _X_m_C_l_i_p_b_o_a_r_d_I_n_q_u_i_r_e_F_o_r_m_a_t (ddddiiiissssppppllllaaaayyyy,,,, wwwwiiiinnnnddddoooowwww,,,, iiiinnnnddddeeeexxxx,,,,    ffffoooorrrrmmmmaaaatttt____nnnnaaaammmmeeee____bbbbuuuuffff,,,,
  17.             bbbbuuuuffffffffeeeerrrr____lllleeeennnn,,,,    ccccooooppppiiiieeeedddd____lllleeeennnn)
  18.            _D_i_s_p_l_a_y      **** ddddiiiissssppppllllaaaayyyy;
  19.            _W_i_n_d_o_w      wwwwiiiinnnnddddoooowwww;
  20.            _i_n_t      iiiinnnnddddeeeexxxx;
  21.            _X_t_P_o_i_n_t_e_r  ffffoooorrrrmmmmaaaatttt____nnnnaaaammmmeeee____bbbbuuuuffff;
  22.            _u_n_s_i_g_n_e_d    _l_o_n_gbbbbuuuuffffffffeeeerrrr____lllleeeennnn;
  23.            _u_n_s_i_g_n_e_d    _l_o_n_g**** ccccooooppppiiiieeeedddd____lllleeeennnn;
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.       _X_m_C_l_i_p_b_o_a_r_d_I_n_q_u_i_r_e_F_o_r_m_a_t returns a specified format name for
  27.       the data item    in the clipboard.  If the name must be
  28.       truncated, the function returns a warning status.
  29.  
  30.       ddddiiiissssppppllllaaaayyyy
  31.            Specifies a pointer to the _D_i_s_p_l_a_y structure that was
  32.            returned    in a previous call to _X_O_p_e_n_D_i_s_p_l_a_y or
  33.            _X_t_D_i_s_p_l_a_y.
  34.  
  35.       wwwwiiiinnnnddddoooowwww
  36.            Specifies a widget's window ID that relates the
  37.            application window to the clipboard.  The widget's
  38.            window ID can be    obtained by using _X_t_W_i_n_d_o_w.  The same
  39.            application instance should pass    the same window    ID to
  40.            each of the clipboard functions that it calls.
  41.  
  42.       iiiinnnnddddeeeexxxx
  43.            Specifies which of the ordered format names to obtain.
  44.            If this index is    greater    than the number    of formats for
  45.            the data    item, this function returns a zero in the
  46.            ccccooooppppiiiieeeedddd____lllleeeennnn argument.
  47.  
  48.       ffffoooorrrrmmmmaaaatttt____nnnnaaaammmmeeee____bbbbuuuuffff
  49.            Specifies the buffer that receives the format name.
  50.  
  51.       bbbbuuuuffffffffeeeerrrr____lllleeeennnn
  52.            Specifies the number of bytes in    the format name
  53.            buffer.
  54.  
  55.       ccccooooppppiiiieeeedddd____lllleeeennnn
  56.            Specifies the number of bytes in    the string copied to
  57.            the buffer.  If this argument equals zero, there    is no
  58.            nnnntttthhhh format for the data item.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  75.       _C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  76.            The function is successful.
  77.  
  78.       _C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  79.            The function failed because the clipboard was locked by
  80.            another application.  The application can continue to
  81.            call the    function again with the    same parameters    until
  82.            the lock    goes away.  This gives the application the
  83.            opportunity to ask if the user wants to keep trying or
  84.            to give up on the operation.
  85.  
  86.       _C_l_i_p_b_o_a_r_d_T_r_u_n_c_a_t_e
  87.            The data    returned is truncated because the user did not
  88.            provide a buffer    large enough to    hold the data.
  89.  
  90.       _C_l_i_p_b_o_a_r_d_N_o_D_a_t_a
  91.            The function could not find data    on the clipboard
  92.            corresponding to    the format requested.  This could
  93.            occur because the clipboard is empty; there is data on
  94.            the clipboard but not in    the requested format; or the
  95.            data in the requested format was    passed by name and is
  96.            no longer available.
  97.  
  98.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  99.       _X_m_C_l_i_p_b_o_a_r_d_S_t_a_r_t_C_o_p_y(_3_X).
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.